<HTML>
<HEAD>
<TITLE>/usr/local/src/sqlrelay-0.25/doc/api/ruby/ruby.html</TITLE>
</HEAD>
<BODY BGcolor=#FFFFFF TEXT=#000000>
<PRE>
<FONT color=#0000f8># Copyright (c) 2001 David Muse</FONT>
<FONT color=#0000f8># See the file COPYING for more information</FONT>

<B><FONT color=#a02828>class</FONT></B> <FONT color=#008888>SQLRConnection</FONT>

<FONT color=#f800f8>    A wrapper for the sqlrelay connection API.  Closely follows the C++ API.</FONT>

    <FONT color=#008888>new</FONT>(host, port, socket, user, password, retrytime, tries)
<FONT color=#f800f8>        Opens a connection to the sqlrelay server and authenticates with</FONT>
<FONT color=#f800f8>        user and password.  Failed connections are retried for tries times</FONT>
<FONT color=#f800f8>        at retrytime interval.  </FONT>
<FONT color=#f800f8>        Initiates a connection to "server" on "port"</FONT>
<FONT color=#f800f8>        or to the unix "socket" on the local machine</FONT>
<FONT color=#f800f8>        and authenticates with "user" and "password".</FONT>
<FONT color=#f800f8>        Failed connections will be retried for</FONT>
<FONT color=#f800f8>        "tries" times on interval "retrytime".</FONT>
<FONT color=#f800f8>        If "tries" is 0 then retries will continue</FONT>
<FONT color=#f800f8>        forever.  If "retrytime" is 0 then retries</FONT>
<FONT color=#f800f8>        will be attempted on a default interval.</FONT>
        
    <FONT color=#008888>endSession</FONT>()
<FONT color=#f800f8>        Ends the current session.</FONT>

    <FONT color=#008888>suspendSession</FONT>()
<FONT color=#f800f8>        Disconnects this connection from the current</FONT>
<FONT color=#f800f8>        session but leaves the session open so </FONT>
<FONT color=#f800f8>        that another connection can connect to it </FONT>
<FONT color=#f800f8>        using resumeSession().</FONT>

    <FONT color=#008888>getConnectionPort</FONT>()
<FONT color=#f800f8>        Returns the inet port that the connection is </FONT>
<FONT color=#f800f8>        communicating over. This parameter may be </FONT>
<FONT color=#f800f8>        passed to another connection for use in</FONT>
<FONT color=#f800f8>        the resumeSession() method.</FONT>
<FONT color=#f800f8>        Note: the value returned by this method is</FONT>
<FONT color=#f800f8>        only valid after a call to suspendSession().</FONT>

    <FONT color=#008888>getConnectionSocket</FONT>()
<FONT color=#f800f8>        Returns the unix socket that the connection is </FONT>
<FONT color=#f800f8>        communicating over. This parameter may be </FONT>
<FONT color=#f800f8>        passed to another connection for use in</FONT>
<FONT color=#f800f8>        the resumeSession() method.</FONT>
<FONT color=#f800f8>        Note: the value returned by this method is</FONT>
<FONT color=#f800f8>        only valid after a call to suspendSession().</FONT>

    <FONT color=#008888>resumeSession</FONT>(port, socket)
<FONT color=#f800f8>        Resumes a session previously left open </FONT>
<FONT color=#f800f8>        using suspendSession().</FONT>
<FONT color=#f800f8>        Returns 1 on success and 0 on failure.</FONT>

    <FONT color=#008888>ping</FONT>()
<FONT color=#f800f8>        Returns 1 if the database is up and 0</FONT>
<FONT color=#f800f8>        if it's down.</FONT>

    <FONT color=#008888>identify</FONT>()
<FONT color=#f800f8>        Returns the type of database </FONT>
<FONT color=#f800f8>          oracle8, postgresql, mysql, etc.</FONT>

    <FONT color=#008888>dbVersion</FONT>()
<FONT color=#f800f8>        Returns the version of the database</FONT>

    <FONT color=#008888>serverVersion</FONT>()
<FONT color=#f800f8>        Returns the version of the SQL Relay server software</FONT>

    <FONT color=#008888>clientVersion</FONT>()
<FONT color=#f800f8>        Returns the version of the SQL Relay client software</FONT>

    <FONT color=#008888>bindFormat</FONT>()
<FONT color=#f800f8>        Returns a string representing the format</FONT>
<FONT color=#f800f8>        of the bind variables used in the db.</FONT>

    <FONT color=#008888>autoCommitOn</FONT>()
<FONT color=#f800f8>        Instructs the database to perform a commit</FONT>
<FONT color=#f800f8>        after every successful query.  Returns a 1</FONT>
<FONT color=#f800f8>        on success, 0 on failure and -1 if an error</FONT>
<FONT color=#f800f8>        occurred. </FONT>

    <FONT color=#008888>autoCommitOff</FONT>()
<FONT color=#f800f8>        Instructs the database to wait for the client</FONT>
<FONT color=#f800f8>        to tell it when to commit.  Returns a 1 on</FONT>
<FONT color=#f800f8>        success, 0 on failure and -1 if an error</FONT>
<FONT color=#f800f8>        occurred. </FONT>

    <FONT color=#008888>commit</FONT>()
<FONT color=#f800f8>        Issues a commit.  Returns a 1 if the commit </FONT>
<FONT color=#f800f8>        succeeded, 0 if it failed and -1 if an </FONT>
<FONT color=#f800f8>        error occurred. </FONT>

    <FONT color=#008888>rollback</FONT>()
<FONT color=#f800f8>        Issues a rollback.  Returns a 1 if the rollback </FONT>
<FONT color=#f800f8>        succeeded, 0 if it failed and -1 if an </FONT>
<FONT color=#f800f8>        error occurred. </FONT>

    <FONT color=#008888>debugOn</FONT>()
<FONT color=#f800f8>        Turn verbose debugging on.</FONT>

    <FONT color=#008888>debugOff</FONT>()
<FONT color=#f800f8>        Turn verbose debugging off.</FONT>

    <FONT color=#008888>getDebug</FONT>()
<FONT color=#f800f8>        Returns 1 if debugging is turned on and 0 if debugging is turned off.</FONT>





<B><FONT color=#a02828>class</FONT></B> <FONT color=#008888>SQLRCursor</FONT>


<FONT color=#f800f8>    A wrapper for the sqlrelay cursor API.  Closely follows the C++ API.</FONT>

    <FONT color=#008888>new</FONT>(sqlrcon)

    <FONT color=#008888>setResultSetBufferSize</FONT>(rows)
<FONT color=#f800f8>        Sets the number of rows of the result set</FONT>
<FONT color=#f800f8>        to buffer at a time.  0 (the default)</FONT>
<FONT color=#f800f8>        means buffer the entire result set.</FONT>

    <FONT color=#008888>getResultSetBufferSize</FONT>()
<FONT color=#f800f8>        Returns the number of result set rows that </FONT>
<FONT color=#f800f8>        will be buffered at a time or 0 for the</FONT>
<FONT color=#f800f8>        entire result set.</FONT>

    <FONT color=#008888>dontGetColumnInfo</FONT>()
<FONT color=#f800f8>        Tells the server not to send any column</FONT>
<FONT color=#f800f8>        info (names, types, sizes).  If you don't</FONT>
<FONT color=#f800f8>        need that info, you should call this</FONT>
<FONT color=#f800f8>        method to improve performance.</FONT>

    <FONT color=#008888>getColumnInfo</FONT>()
<FONT color=#f800f8>        Tells the server to send column info.</FONT>

    <FONT color=#008888>mixedCaseColumnNames</FONT>()
<FONT color=#f800f8>        Columns names are returned in the same</FONT>
<FONT color=#f800f8>        case as they are defined in the database.</FONT>
<FONT color=#f800f8>        This is the default.</FONT>

    <FONT color=#008888>upperCaseColumnNames</FONT>()
<FONT color=#f800f8>        Columns names are converted to upper case.</FONT>

    <FONT color=#008888>lowerCaseColumnNames</FONT>()
<FONT color=#f800f8>        Columns names are converted to lower case.</FONT>

    <FONT color=#008888>cacheToFile</FONT>(filename)
<FONT color=#f800f8>        Sets query caching on.  Future queries</FONT>
<FONT color=#f800f8>        The full pathname of the file can be</FONT>
<FONT color=#f800f8>        retrieved using getCacheFileName().</FONT>
<FONT color=#f800f8>        </FONT>
<FONT color=#f800f8>        A default time-to-live of 10 minutes is</FONT>
<FONT color=#f800f8>        also set.</FONT>
<FONT color=#f800f8>        </FONT>
<FONT color=#f800f8>        Note that once cacheToFile() is called,</FONT>
<FONT color=#f800f8>        the result sets of all future queries will</FONT>
<FONT color=#f800f8>        be cached to that file until another call </FONT>
<FONT color=#f800f8>        to cacheToFile() changes which file to</FONT>
<FONT color=#f800f8>        cache to or a call to cacheOff() turns off</FONT>
<FONT color=#f800f8>        caching.</FONT>

    <FONT color=#008888>setCacheTtl</FONT>(ttl)
<FONT color=#f800f8>        Sets the time-to-live for cached result</FONT>
<FONT color=#f800f8>        sets. The sqlr-cachemanger will remove each </FONT>
<FONT color=#f800f8>        cached result set &quot;ttl&quot; seconds after it's </FONT>
<FONT color=#f800f8>        created.</FONT>

    <FONT color=#008888>getCacheFileName</FONT>()
<FONT color=#f800f8>        Returns the name of the file containing the most</FONT>
<FONT color=#f800f8>        recently cached result set.</FONT>

    <FONT color=#008888>cacheOff</FONT>()
<FONT color=#f800f8>        Sets query caching off.</FONT>


<FONT color=#f800f8>    If you don't need to use substitution or bind variables</FONT>
<FONT color=#f800f8>    in your queries, use these two methods.</FONT>
    <FONT color=#008888>sendQuery</FONT>(query)
<FONT color=#f800f8>        Send a SQL query to the server and</FONT>
<FONT color=#f800f8>        gets a result set.</FONT>

    <FONT color=#008888>sendQueryWithLength</FONT>(query)
<FONT color=#f800f8>        Sends "query" with length "length" and gets</FONT>
<FONT color=#f800f8>        a result set. This method must be used if</FONT>
<FONT color=#f800f8>        the query contains binary data.</FONT>

    <FONT color=#008888>sendFileQuery</FONT>(path, file)
<FONT color=#f800f8>        Send the SQL query in path/file to the server and</FONT>
<FONT color=#f800f8>        gets a result set.</FONT>

<FONT color=#f800f8>    If you need to use substitution or bind variables, in your</FONT>
<FONT color=#f800f8>    queries use the following methods.  See the API documentation</FONT>
<FONT color=#f800f8>    for more information about substitution and bind variables.</FONT>
    <FONT color=#008888>prepareQuery</FONT>(query)
<FONT color=#f800f8>        Prepare to execute query.</FONT>

    <FONT color=#008888>prepareQueryWithLength</FONT>(query, length)
<FONT color=#f800f8>        Prepare to execute "query" with length</FONT>
<FONT color=#f800f8>        "length".  This method must be used if the</FONT>
<FONT color=#f800f8>        query contains binary data.</FONT>

    <FONT color=#008888>prepareFileQuery</FONT>(path, file)
<FONT color=#f800f8>        Prepare to execute the contents of path/filename.</FONT>

    <FONT color=#008888>clearBinds</FONT>()
<FONT color=#008888>        Clear all bind variables.</FONT>

    <FONT color=#008888>countBindVariables</FONT>()
<FONT color=#008888>        Parses the previously prepared query,</FONT>
<FONT color=#008888>        counts the number of bind variables defined</FONT>
<FONT color=#008888>        in it and returns that number.</FONT>

    <FONT color=#008888>substitution</FONT>(variable, value, [precision, scale])
<FONT color=#f800f8>        Define a substitution variable.</FONT>
<FONT color=#f800f8>        Precision and scale are only</FONT>
<FONT color=#f800f8>        necessary for floating point</FONT>
<FONT color=#f800f8>        Returns true if the variable was successfully substituted or false if</FONT>
<FONT color=#f800f8>        the variable isn't a string, integer or floating point number, or if</FONT>
<FONT color=#f800f8>        precision and scale aren't provided for a floating point number.</FONT>
<FONT color=#f800f8>        values.</FONT>

    <FONT color=#008888>inputBind</FONT>(variable, value, [precision, scale])
<FONT color=#f800f8>        Define an input bind varaible.</FONT>
<FONT color=#f800f8>        Precision and scale are only</FONT>
<FONT color=#f800f8>        necessary for floating point</FONT>
<FONT color=#f800f8>        Returns true if the variable was successfully bound or false if the</FONT>
<FONT color=#f800f8>        variable isn't a string, integer or floating point number, or if</FONT>
<FONT color=#f800f8>        precision and scale aren't provided for a floating point number.</FONT>
<FONT color=#f800f8>        values.</FONT>

    <FONT color=#008888>defineOutputBindString</FONT>(variable, length)
<FONT color=#f800f8>        Define a string output bind varaible.</FONT>
<FONT color=#f800f8>        "length" bytes will be reserved to store the result.</FONT>
    <FONT color=#008888>defineOutputBindInteger</FONT>(variable)
<FONT color=#f800f8>        Define an integer output bind varaible.</FONT>
<FONT color=#f800f8>        "length" bytes will be reserved to store the result.</FONT>
    <FONT color=#008888>defineOutputBindDouble</FONT>(variable)
<FONT color=#f800f8>        Define a double precision floating point</FONT>
<FONT color=#f800f8>        output bind varaible.</FONT>
    <FONT color=#008888>defineOutputBindBlob</FONT>(variable)
<FONT color=#f800f8>        Define a BLOB output bind varaible.</FONT>
    <FONT color=#008888>defineOutputBindClob</FONT>(variable)
<FONT color=#f800f8>        Define a CLOB output bind varaible.</FONT>
    <FONT color=#008888>defineOutputBindCursor</FONT>(variable)
<FONT color=#f800f8>        Define a cursor output bind varaible.</FONT>


<FONT color=#f800f8>    These functions take arrays for parameters</FONT>
    <FONT color=#008888>substitutions</FONT>(variables, values, [precisions, scales])
<FONT color=#f800f8>        Define substitution variables.</FONT>
<FONT color=#f800f8>        Precisions and scales are only</FONT>
<FONT color=#f800f8>        necessary for floating point</FONT>
<FONT color=#f800f8>        values.</FONT>
<FONT color=#f800f8>        Returns true if the variables were successfully substituted or false if</FONT>
<FONT color=#f800f8>        one of the variables wasn't a string, integer or floating point number,</FONT>
<FONT color=#f800f8>        or if precision and scale weren't provided for a floating point number.</FONT>

    <FONT color=#008888>inputBinds</FONT>(variables, values, [precisions, scales])
<FONT color=#f800f8>        Define input bind variables.</FONT>
<FONT color=#f800f8>        Precisions and scales are only</FONT>
<FONT color=#f800f8>        necessary for floating point</FONT>
<FONT color=#f800f8>        Returns true if the variables were successfully bound or false if one</FONT>
<FONT color=#f800f8>        of the variables wasn't a string, integer or floating point number,</FONT>
<FONT color=#f800f8>        or if precision and scale weren't provided for a floating point number.</FONT>
<FONT color=#f800f8>        values.</FONT>
        

    <FONT color=#008888>validateBinds</FONT>()
<FONT color=#f800f8>        If you are binding to any variables that </FONT>
<FONT color=#f800f8>        might not actually be in your query, call </FONT>
<FONT color=#f800f8>        this to ensure that the database won't try </FONT>
<FONT color=#f800f8>        to bind them unless they really are in the </FONT>
<FONT color=#f800f8>        query.</FONT>
        

    <FONT color=#008888>validBind</FONT>(variable)
<FONT color=#f800f8>        Returns true if "variable" was a valid bind </FONT>
<FONT color=#f800f8>        variable of the query.</FONT>

    <FONT color=#008888>executeQuery</FONT>()
<FONT color=#f800f8>        Execute the query that was previously</FONT>
<FONT color=#f800f8>        prepared and bound.</FONT>

    <FONT color=#008888>fetchFromBindCursor</FONT>()
<FONT color=#f800f8>        Fetch from a cursor that was returned as</FONT>
<FONT color=#f800f8>        an output bind variable.</FONT>

    <FONT color=#008888>getOutputBindString</FONT>(variable)
<FONT color=#f800f8>        Retrieve the value of an output bind variable.</FONT>

    <FONT color=#008888>getOutputBindBlob</FONT>(variable)
<FONT color=#f800f8>        Retrieve the value of an output bind variable.</FONT>

    <FONT color=#008888>getOutputBindClob</FONT>(variable)
<FONT color=#f800f8>        Retrieve the value of an output bind variable.</FONT>

    <FONT color=#008888>getOutputBindInteger</FONT>(variable)
<FONT color=#f800f8>        Retrieve the value of an output bind variable.</FONT>

    <FONT color=#008888>getOutputBindDouble</FONT>(variable)
<FONT color=#f800f8>        Retrieve the value of an output bind variable.</FONT>

    <FONT color=#008888>getOutputBindLength</FONT>(variable)
<FONT color=#f800f8>        Get the length of the value stored in a</FONT>
<FONT color=#f800f8>        previously defined output bind variable.</FONT>

    <FONT color=#008888>getOutputBindCursor</FONT>(variable)
<FONT color=#f800f8>        Get the cursor associated with a previously</FONT>
<FONT color=#f800f8>        defined output bind variable.</FONT>


    <FONT color=#008888>openCachedResultSet</FONT>(filename)
<FONT color=#f800f8>        Open a result set after a sendCachedQeury</FONT>

    <FONT color=#008888>colCount</FONT>()
<FONT color=#f800f8>        Returns the number of columns in the current result set.</FONT>

    <FONT color=#008888>rowCount</FONT>()
<FONT color=#f800f8>        Returns the number of rows in the current result set.</FONT>

    <FONT color=#008888>totalRows</FONT>()
<FONT color=#f800f8>        Returns the total number of rows that will </FONT>
<FONT color=#f800f8>        be returned in the result set.  Not all </FONT>
<FONT color=#f800f8>        databases support this call.  Don't use it </FONT>
<FONT color=#f800f8>        for applications which are designed to be </FONT>
<FONT color=#f800f8>        portable across databases.  -1 is returned</FONT>
<FONT color=#f800f8>        by databases which don't support this option.</FONT>

    <FONT color=#008888>affectedRows</FONT>()
<FONT color=#f800f8>        Returns the number of rows that were </FONT>
<FONT color=#f800f8>        updated, inserted or deleted by the query.</FONT>
<FONT color=#f800f8>        Not all databases support this call.  Don't </FONT>
<FONT color=#f800f8>        use it for applications which are designed </FONT>
<FONT color=#f800f8>        to be portable across databases.  -1 is </FONT>
<FONT color=#f800f8>        returned by databases which don't support </FONT>
<FONT color=#f800f8>        this option.</FONT>

    <FONT color=#008888>firstRowIndex</FONT>()
<FONT color=#f800f8>        Returns the index of the first buffered row.</FONT>
<FONT color=#f800f8>        This is useful when buffering only part of</FONT>
<FONT color=#f800f8>        the result set at a time.</FONT>

    <FONT color=#008888>endOfResultSet</FONT>()
<FONT color=#f800f8>        Returns 0 if part of the result set is still</FONT>
<FONT color=#f800f8>        pending on the server and 1 if not.  This</FONT>
<FONT color=#f800f8>        method can only return 0 if </FONT>
<FONT color=#f800f8>        setResultSetBufferSize() has been called</FONT>
<FONT color=#f800f8>        with a parameter other than 0.</FONT>

    <FONT color=#008888>errorMessage</FONT>()
<FONT color=#f800f8>        If the query failed, the error message will be returned</FONT>
<FONT color=#f800f8>        from this method.  Otherwise, it returns None.</FONT>

    <FONT color=#008888>getNullsAsEmptyStrings</FONT>()
<FONT color=#f800f8>        Tells the cursor to return NULL fields and output</FONT>
<FONT color=#f800f8>        bind variables as empty strings.</FONT>
<FONT color=#f800f8>        This is the default.</FONT>

    <FONT color=#008888>getNullsAsNone</FONT>()
<FONT color=#f800f8>        Tells the cursor to return NULL fields and output</FONT>
<FONT color=#f800f8>        bind variables as NULL's.</FONT>

    <FONT color=#008888>getField</FONT>(row, col)
<FONT color=#f800f8>        Returns the value of the specified row and</FONT>
<FONT color=#f800f8>        column.  col may be a column name or number.</FONT>

    <FONT color=#008888>getFieldLength</FONT>(row, col)
<FONT color=#f800f8>        Returns the length of the specified row and</FONT>
<FONT color=#f800f8>        column.  col may be a column name or number.</FONT>

    <FONT color=#008888>getRow</FONT>(row)
<FONT color=#f800f8>        Returns a list of values in the given row.</FONT>

    <FONT color=#008888>getRowHash</FONT>(row)
<FONT color=#f800f8>        Returns the requested row as values in a dictionary</FONT>
<FONT color=#f800f8>        with column names for keys.</FONT>

    <FONT color=#008888>getRowRange</FONT>(beg, end)
<FONT color=#f800f8>        Returns a list of lists of the rows between beg and end.</FONT>
<FONT color=#f800f8>        Note this function has no equivalent in other SQL Relay API's.</FONT>

    <FONT color=#008888>getRowLengths</FONT>(row)
<FONT color=#f800f8>        Returns a list of lengths in the given row.</FONT>

    <FONT color=#008888>getRowLengthsHash</FONT>(row)
<FONT color=#f800f8>        Returns the requested row lengths as values in a dictionary</FONT>
<FONT color=#f800f8>        with column names for keys.</FONT>

    <FONT color=#008888>getRowLengthsRange</FONT>(beg, end)
<FONT color=#f800f8>        Returns a list of lists of the lengths of rows between beg and end.</FONT>
<FONT color=#f800f8>        Note this function has no equivalent in other SQL Relay API's.</FONT>

    <FONT color=#008888>getColumnName</FONT>(col)
<FONT color=#f800f8>        Returns the name of column number col.</FONT>

    <FONT color=#008888>getColumnNames</FONT>()
<FONT color=#f800f8>        Returns a list of column names in the current result set.</FONT>

    <FONT color=#008888>getColumnType</FONT>(col)
<FONT color=#f800f8>        Returns the type of the specified column.  col may</FONT>
<FONT color=#f800f8>        be a name or number.</FONT>

    <FONT color=#008888>getColumnLength</FONT>(col)
<FONT color=#f800f8>        Returns the length of the specified column.  col may</FONT>
<FONT color=#f800f8>        be a name or number.</FONT>

    <FONT color=#008888>getColumnPrecision</FONT>(col)
<FONT color=#f800f8>        Returns the precision of the specified
column.</FONT>
<FONT color=#f800f8>        Precision is the total number of digits in</FONT>
<FONT color=#f800f8>        a number.  eg: 123.45 has a precision of 5.</FONT>
<FONT color=#f800f8>        For non-numeric types, it's the number of</FONT>
<FONT color=#f800f8>        characters in the string.</FONT>

    <FONT color=#008888>getColumnScale</FONT>(col)
<FONT color=#f800f8>        Returns the scale of the specified column.</FONT>
<FONT color=#f800f8>        Scale is the total number of digits to the</FONT>
<FONT color=#f800f8>        right of the decimal point in a number.</FONT>
<FONT color=#f800f8>        eg: 123.45 has a scale of 2.</FONT>

    <FONT color=#008888>getColumnIsNullable</FONT>(col)
<FONT color=#f800f8>        Returns 1 if the specified column can</FONT>
<FONT color=#f800f8>        contain nulls and 0 otherwise.</FONT>

    <FONT color=#008888>getColumnIsPrimaryKey</FONT>(col)
<FONT color=#f800f8>        Returns 1 if the specified column is a</FONT>
<FONT color=#f800f8>        primary key and 0 otherwise.</FONT>

    <FONT color=#008888>getColumnIsUnique</FONT>(col)
<FONT color=#f800f8>        Returns 1 if the specified column is</FONT>
<FONT color=#f800f8>        unique and 0 otherwise.</FONT>

    <FONT color=#008888>getColumnIsPartOfKey</FONT>(col)
<FONT color=#f800f8>        Returns 1 if the specified column is</FONT>
<FONT color=#f800f8>        part of a composite key and 0 otherwise.</FONT>

    <FONT color=#008888>getColumnIsUnsigned</FONT>(col)
<FONT color=#f800f8>        Returns 1 if the specified column is</FONT>
<FONT color=#f800f8>        an unsigned number and 0 otherwise.</FONT>

    <FONT color=#008888>getColumnIsZeroFilled</FONT>(col)
<FONT color=#f800f8>        Returns 1 if the specified column was</FONT>
<FONT color=#f800f8>        created with the zero-fill flag and 0</FONT>
<FONT color=#f800f8>        otherwise.</FONT>

    <FONT color=#008888>getColumnIsBinary</FONT>(col)
<FONT color=#f800f8>        Returns 1 if the specified column</FONT>
<FONT color=#f800f8>        contains binary data and 0</FONT>
<FONT color=#f800f8>        otherwise.</FONT>

    <FONT color=#008888>getColumnIsAutoIncrement</FONT>(col)
<FONT color=#f800f8>        Returns 1 if the specified column</FONT>
<FONT color=#f800f8>        auto-increments and 0 otherwise.</FONT>

    <FONT color=#008888>getLongest</FONT>(col)
<FONT color=#f800f8>        Returns the length of the specified column.  col may</FONT>
<FONT color=#f800f8>        be a name or number.</FONT>

    <FONT color=#008888>suspendResultSet</FONT>()
<FONT color=#f800f8>        Tells the server to leave this result</FONT>
<FONT color=#f800f8>        set open when the cursor calls </FONT>
<FONT color=#f800f8>        suspendSession() so that another cursor can </FONT>
<FONT color=#f800f8>        connect to it using resumeResultSet() after </FONT>
<FONT color=#f800f8>        it calls resumeSession().</FONT>

    <FONT color=#008888>getResultSetId</FONT>()
<FONT color=#f800f8>        Returns the internal ID of this result set.</FONT>
<FONT color=#f800f8>        This parameter may be passed to another </FONT>
<FONT color=#f800f8>        cursor for use in the resumeResultSet() </FONT>
<FONT color=#f800f8>        method.</FONT>
<FONT color=#f800f8>        Note: the value returned by this method is</FONT>
<FONT color=#f800f8>        only valid after a call to suspendResultSet().</FONT>

    <FONT color=#008888>resumeResultSet</FONT>(id)
<FONT color=#f800f8>        Resumes a result set previously left open </FONT>
<FONT color=#f800f8>        using suspendSession().</FONT>
<FONT color=#f800f8>        Returns 1 on success and 0 on failure.</FONT>

    <FONT color=#008888>resumeCachedResultSet</FONT>(id, filename)
<FONT color=#f800f8>        Resumes a result set previously left open</FONT>
<FONT color=#f800f8>        using suspendSession() and continues caching</FONT>
<FONT color=#f800f8>        Returns 1 on success and 0 on failure.</FONT>
</PRE>
</BODY>
</HTML>
